Skip to content

docs: add CONTRIBUTING.md and align README structure with repo#293

Open
tejeshvenkat wants to merge 2 commits intoOWASP-BLT:mainfrom
tejeshvenkat:docs/contributing-and-readme-accuracy
Open

docs: add CONTRIBUTING.md and align README structure with repo#293
tejeshvenkat wants to merge 2 commits intoOWASP-BLT:mainfrom
tejeshvenkat:docs/contributing-and-readme-accuracy

Conversation

@tejeshvenkat
Copy link
Copy Markdown

@tejeshvenkat tejeshvenkat commented Mar 23, 2026 •
edited by coderabbitai bot
Loading

  • CONTRIBUTING: local dev, npm ci/test, compileall, PR workflow, links to docs/
  • README: link to CONTRIBUTING; project tree matches actual files; remove broken refs to missing TESTING.md, test-simple.js, test-production.js; document test-sorting-security.js

Summary by CodeRabbit

  • Documentation
    • Added comprehensive contribution guidelines covering prerequisites, step‑by‑step local development setup, testing and sanity checks, pull request workflow standards, and community support channels.
    • Updated README to reflect the revised repository structure and to streamline testing and local development instructions.

@tejeshvenkat
docs: add CONTRIBUTING.md and align README structure with repo
a632a14 
- CONTRIBUTING: local dev, npm ci/test, compileall, PR workflow, links to docs/
- README: link to CONTRIBUTING; project tree matches actual files; remove
  broken refs to missing TESTING.md, test-simple.js, test-production.js;
  document test-sorting-security.js
@owasp-blt
Copy link
Copy Markdown

owasp-blt bot commented Mar 23, 2026

📊 Monthly Leaderboard

Hi @tejeshvenkat! Here's how you rank for March 2026:

Rank User Open PRs PRs (merged) PRs (closed) Reviews Comments Total
19 YASHvardhanVashistha @YASHvardhanVashistha 1 13 0 0 0 131
20 tejeshvenkat @tejeshvenkat ✨ 13 7 1 4 15 131
21 snigdhachoudhury @snigdhachoudhury 2 12 0 0 0 122

Scoring this month (across OWASP-BLT org): Open PRs (+1 each), Merged PRs (+10), Closed (not merged) (−2), Reviews (+5; first two per PR in-month), Comments (+2, excludes CodeRabbit). Run /leaderboard on any issue or PR to see your rank!

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 23, 2026

🍃 PR Readiness Check

Check the readiness of this PR on Leaf:
👉 Open on Leaf

Leaf reviews pull requests for operational readiness, security risks, and production-impacting changes before they ship.

@owasp-blt
Copy link
Copy Markdown

owasp-blt bot commented Mar 23, 2026

👋 Hi @tejeshvenkat!

This pull request needs a peer review before it can be merged. Please request a review from a team member who is not:

  • The PR author
  • coderabbitai
  • copilot

Once a valid peer review is submitted, this check will pass automatically. Thank you!

⚠️ Peer review enforcement is active.

@github-actions github-actions bot added the files-changed: 2 PR changes 2 files label Mar 23, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 23, 2026 •
edited
Loading

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: OWASP-BLT/coderabbit/.coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: a3a4bd86-3204-4f00-a488-56db18d6a200

📥 Commits

Reviewing files that changed from the base of the PR and between a632a14 and f51d7d9.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Walkthrough

Added a new CONTRIBUTING.md with development, testing, and PR workflow instructions; updated README.md to reference the new contributing guide, adjust repository structure notes, and replace the previous quick test with test-sorting-security.js.

Changes

Cohort / File(s) Summary
New Contribution Guidelines
CONTRIBUTING.md		 New file documenting prerequisites (Node 22+, Python 3.11+), local dev setup (npm ci, .env from .env.example), D1 database setup and migrations, running the worker locally, Python compile sanity check, test commands (npm test, node test-sorting-security.js), PR workflow, CI checks, and support/licensing notes.
Documentation Updates
README.md		 Added pointer to CONTRIBUTING.md, updated repository structure (expanded public/, src/..., added docs/), and replaced the old quick/full test instructions with node test-sorting-security.js and removed references to deprecated test docs.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: adding CONTRIBUTING.md documentation and updating README to reflect the actual repository structure.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]
coderabbitai bot requested changes Mar 23, 2026
View reviewed changes
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents 
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CONTRIBUTING.md`:
- Line 12: Update the CONTRIBUTING.md entry that lists the CI commands so the
`npm audit` invocation matches CI exactly: change the listed command to `npm
audit --audit-level=high` (the same flag used in .github/workflows/ci.yml) when
enumerating the commands `npm run lint`, `npm run format:check`, `npm test`,
`npm audit` so the docs and CI stay in sync.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository: OWASP-BLT/coderabbit/.coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 2ac16bd9-7399-4b54-b9ae-d0f70a937c55

📥 Commits

Reviewing files that changed from the base of the PR and between 4b3d830 and a632a14.

📒 Files selected for processing (2)
  • CONTRIBUTING.md
  • README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees

No one assigned

Labels

files-changed: 2 PR changes 2 files needs-peer-review PR needs peer review unresolved-conversations: 0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@tejeshvenkat